@ensono-stacks/[plugin-name]
Summary of the plugin What is its purpose?
What benefits does it give you?
Setting up @ensono-stacks/[plugin-name]
Prerequisites
Are there any prerequisites?
Installation
Install the @ensono-stacks/[plugin-name] with the following command:
- npm
- yarn
npm install --save-dev @ensono-stacks/[plugin-name]
yarn add --dev @ensono-stacks/[plugin-name]
Has it installed any additional plugins
What are they? Can we link to docs about the additional plugins?
Has it created any scripts
How do we use them, what do those scripts do? e.g
"scripts": {
"prepare": "husky install"
},
Executors and Generators
To see a list of the plugin capabilities run the following command:
nx list @ensono-stacks/[plugin-name]
View additional information about a plugin capability through the following command:
nx g @ensono-stacks/[plugin-name]:[generator-executor-name] --help
Executors
@ensono-stacks/[plugin-name]:generator/executor name
Details
Very brief description (E.g Add Next Authentication to your next application)
What does the generator/executor do?Prerequisites
Are there any prerequisites?
Usage
nx @ensono-stacks/[plugin-name]:generator/executor --Option1 Option1Value --Option2 Option2Value
Command line arguments
The following command line arguments are available:
Option | Description | Type | Accepted Values | Default |
---|---|---|---|---|
--Option1 | Option 1 description | boolean | true/false | true |
--Option2 | Option 2 description | string | default-string |
Generator Output
What is the output of the above commands
Will it create new files, will it manipulate existing ones?
.
├── main folder created
│ ├── file which gets created
│ ├── second file which gets created
└── second folder created
@ensono-stacks/[plugin-name]:generator/executor name
Details
Very brief description (E.g Add Next Authentication to your next application)
What does the generator/executor do?Prerequisites
Are there any prerequisites?
Usage
nx @ensono-stacks/[plugin-name]:generator/executor --Option1 Option1Value --Option2 Option2Value
Command line arguments
The following command line arguments are available:
Option | Description | Type | Accepted Values | Default |
---|---|---|---|---|
--Option1 | Option 1 description | boolean | true/false | true |
--Option2 | Option 2 description | string | default-string |
Generator Output
What is the output of the above commands
Will it create new files, will it manipulate existing ones?
.
├── main folder created
│ ├── file which gets created
│ ├── second file which gets created
└── second folder created
@ensono-stacks/[plugin-name]:generator/executor name
Details
Very brief description (E.g Add Next Authentication to your next application)
What does the generator/executor do?Prerequisites
Are there any prerequisites?
Usage
nx @ensono-stacks/[plugin-name]:generator/executor --Option1 Option1Value --Option2 Option2Value
Command line arguments
The following command line arguments are available:
Option | Description | Type | Accepted Values | Default |
---|---|---|---|---|
--Option1 | Option 1 description | boolean | true/false | true |
--Option2 | Option 2 description | string | default-string |
Generator Output
What is the output of the above commands
Will it create new files, will it manipulate existing ones?
.
├── main folder created
│ ├── file which gets created
│ ├── second file which gets created
└── second folder created
Generators
@ensono-stacks/[plugin-name]:generator/executor name
Details
Very brief description (E.g Add Next Authentication to your next application)
What does the generator/executor do?Prerequisites
Are there any prerequisites?
Usage
nx @ensono-stacks/[plugin-name]:generator/executor --Option1 Option1Value --Option2 Option2Value
Command line arguments
The following command line arguments are available:
Option | Description | Type | Accepted Values | Default |
---|---|---|---|---|
--Option1 | Option 1 description | boolean | true/false | true |
--Option2 | Option 2 description | string | default-string |
Generator Output
What is the output of the above commands
Will it create new files, will it manipulate existing ones?
.
├── main folder created
│ ├── file which gets created
│ ├── second file which gets created
└── second folder created